<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>skalibs: configuration flags</title>
    <meta name="Description" content="skalibs: configuration flags" />
    <meta name="Keywords" content="skalibs build compilation configuration flags options" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="index.html">skalibs</a><br />
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> skalibs configuration flags </h1>

<p>
 The skalibs <tt>./configure</tt> script comes with a few
uncommon options; this page explains what they are for.
</p>

<a name="slashpackage"><h3> --enable-slashpackage[=<em>sproot</em>] </h3></a>

<p>
 This flag tells configure that you want to install skalibs according to
the <a href="http://cr.yp.to/slashpackage.html">slashpackage convention</a>.
If you enable it, and $v is the version of skalibs you're compiling,
<tt>make install</tt> will install the skalibs header files in
<tt>/package/prog/skalibs-$v/include</tt>, the static libraries in
<tt>/package/prog/skalibs-$v/library</tt>, the dynamic libraries in
<tt>/package/prog/skalibs-$v/library.so</tt> and the data files in
<tt>/package/prog/skalibs-$v/etc</tt>, all prefixed by <em>sproot</em>
if present.
</p>

<p>
  It will also prepend the default path with <tt>/command</tt>, unless an
explicit default path has been given via the
<a href="#defaultpath"><tt>--with-default-path</tt></a> option.
</p>

<p>
 Additionally, it will add two more "make" targets:
</p>

<ul>
 <li> <tt>make update</tt> will update the <tt>/package/prog/skalibs</tt>
symbolic link to point to <tt>skalibs-$v</tt> </li>
 <li> <tt>make -L global-links </tt> will make links from <tt>/library.so</tt>
to the installed skalibs shared libraries. </li>
</ul>

<p>
 If this option is not given, no slashpackage support will be provided.
</p>

<a name="clockistai"><h3> --enable-tai-clock </h3></a>

<p>
 To understand what this flag is about - and the next two flags too - you
should start by reading
<a href="http://www.madore.org/~david/computers/unix-leap-seconds.html">this
page about Unix time</a>,
which <a href="http://www.madore.org/~david/">David Madore</a> wrote after
a long and fairly complete discussion we had on the subject. You can also
read <a href="http://cr.yp.to/proto/utctai.html">what DJB says about Unix time</a>.
Unfortunately, when he says "the POSIX rules are so outrageously dumb (...)
that no self-respecting engineer would obey them", DJB is wrong: a lot of
people follow the POSIX rules. Or maybe he's right... and there are very,
very few self-respecting engineers.
</p>

<p>
 Basically, when you configure a Unix system, there are essentially two
ways to deal with your system clock.
</p>

<ol>
 <li> You can set your system clock to TAI-10, which is the "right", but
uncommon, thing to do:
  <ul>
   <li> &uarr; The main advantage of this setup is that it makes your system clock
<em>linear</em>. In other words,
<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/gettimeofday.html">gettimeofday()</a>
becomes suitable for both timestamping (which needs absolute time) and timeout
computations (which need reliable interval measurements); if your clock is
accurate enough, it can function as both a wall clock and a stopwatch.
This simplifies keeping track of the current time <strong>considerably</strong>,
and makes event loop handling (with functions such as
<a href="libstddjb/iopause.html">iopause()</a>) trivial. </li>
   <li> &uarr; skalibs uses TAI internally; setting your system clock to TAI-10
saves a lot of conversions and makes time computations with skalibs more
efficient. </li>
   <li> &rarr; skalibs-aware software will display GMT or local time properly in
every case, but you have to
use the <tt>right/</tt> timezones, from Arthur David Olson's timezone
library, to prevent your other software from being confused by a TAI-10 system clock.
If you do not use <tt>right/</tt> timezones, utilities such as <tt>date</tt>
will not compute the proper time - they will have an offset of 24 seconds
or so. </li>
   <li> &darr; This setup is arguably not SUSv4 conformant (a strict
interpretation of Single Unix requires the system clock to be set to UTC). </li>
   <li> &darr; This setup is <em>not</em> compatible with
<a href="http://en.wikipedia.org/wiki/Ntpd">ntpd</a>. <tt>ntpd</tt>'s design
is flawed: it makes the mistake of setting the system clock itself - instead
of simply making the computed time available to other programs, one of which
could set the system clock - and it always sets it to UTC. (The
<a href="//skarnet.org/software/s6-networking/">s6-networking</a>
package provides alternate ways to synchronize your clock, though.) </li>
  </ul>
 </li>
 <li> You can set your system clock to UTC, which is the common, strictly
POSIX setup:
  <ul>
   <li> &uarr; This is strictly SUSv4-compliant. Most Unix machines all over
the world are set up like this. </li>
   <li> &uarr; This is compatible with ntpd. </li>
   <li> &rarr; You should use <tt>posix/</tt> time zones in that case,
not <tt>right/</tt> time zones. </li>
   <li> &darr; skalibs time computations will take a bit more processing power. </li>
   <li> &darr; Most importantly, you forsake all linearity - and even monotonicity
- on your system clock, which can now only be used as a wall clock,
<em>not</em> as a stopwatch. skalibs will try its best to do accurate time
computations, but there's no way <tt>gettimeofday()</tt> can be relied on
when a leap second is nearby; you have to use CLOCK_MONOTONIC as a stopwatch
for accurate interval measurement. </li>
  </ul>
 </li>
</ol>

<p>
 Use <tt>--enable-tai-clock</tt> if your system clock is set to TAI-10.
I generally recommend this setup
for computers you have full control on, on which you install and tweak
the software your way, like manually administered servers or embedded
boxes. If you do not run ntpd and do not mind breaking POSIX, it is the
sensible choice.
</p>

<p>
 Do not use this option if your system clock is set to UTC, i.e. if
you're in none of the above cases: you are a
POSIX freak, or your Unix distribution is running ntpd for you, or
other software is assuming you're on UTC. This is the default.
</p>

<a name="usert"><h3> --enable-clock </h3></a>

<p>
 The Open Group Base Specifications, issue 7, describes <tt>gettimeofday()</tt>
as obsolescent, and recommends the use of
<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/clock_gettime.html">clock_gettime()</a>
with the CLOCK_REALTIME option instead. However:
</p>

<ul>
 <li> <tt>clock_gettime()</tt> is not as portable; for instance, Darwin does not have it. </li>
 <li> On most systems, using the <tt>clock_</tt> functions requires linking with <tt>librt</tt>,
which is slightly inconvenient - and silly if all you want is timestamping.
</ul>

<p>
 If <tt>--enable-clock</tt> is set, the <a href="libstddjb/tai.html">tain_now()
and tain_setnow()</a> functions for getting and setting time will be based on
the <tt>clock_gettime()</tt> and <tt>clock_settime()</tt> functions.
</p>

<p>
 Otherwise, the old-school <tt>gettimeofday()</tt>
and <tt>settimeofday()</tt> interfaces will be used. This is the default,
and it's usually safe.
</p>

<a name="usemon"><h3> --enable-monotonic </h3></a>

<p>
 Unless you have an accurate hardware system clock <em>and</em> you set it
on a linear time scale such as TAI-10 instead of UTC (see above), it is
generally a bad idea to trust the system clock for precise time interval
measurements. Single Unix recommends the use of <tt>clock_gettime()</tt>
with the CLOCK_MONOTONIC option to do such measurements: a stopwatch, not
a wall clock. However:
</p>

<ul>
 <li> CLOCK_MONOTONIC is even less portable than CLOCK_REALTIME. </li>
 <li> It's a bit tricky to emulate absolute time calculations based on
CLOCK_MONOTONIC. </li>
</ul>

<p>
 If <tt>--enable-monotonic</tt> is set, then the absolute time given by the
<tt>tain_now()</tt> call will be computed with CLOCK_MONOTONIC. This
will ensure precise time arithmetic but may drift away from the system
clock.
</p>

<p>
 Otherwise, <tt>tain_now()</tt> will
return a time based on the system clock, and not use CLOCK_MONOTONIC.
This is the default.
</p>

<a name="noipv6"><h3> --disable-ipv6 </h3></a>

<p>
 If you set this option, then skalibs will be compiled without IPv6 support,
even if your target architecture supports it. This can significantly
reduce the size of your networking applications if they don't need IPv6
support.
</p>

<p>
 If you don't set this option, then skalibs will include IPv6 support in the
relevant networking functions if and only if the target architecture supports it.
This is the default, and it is safe.
</p>

<a name="defaultpath"><h3> --with-default-path=<em>path</em> </h3></a>

<p>
 The <a href="libstddjb/djbunix.html">execvep()</a> function uses
the value of the PATH environment variable as its executable search path.
Specifying this option to configure tells execvep() what executable
search path to use when PATH is undefined (which should not happen
often anyway).
 The default is <tt>/usr/bin:/usr/sbin:/bin:/sbin</tt>, which is usually safe.
</p>

</body>
</html>
